<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
  <meta name="description" content="API docs for the feedInt16FromStream method from the FlutterSoundPlayer class, for the Dart programming language.">
  <title>feedInt16FromStream method - FlutterSoundPlayer class - flutter_sound_player library - Dart API</title>


  
  <link rel="preconnect" href="https://fonts.gstatic.com">
  <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
  <link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0" rel="stylesheet">
  
  <link rel="stylesheet" href="../../static-assets/github.css?v1">
  <link rel="stylesheet" href="../../static-assets/styles.css?v1">
  <link rel="icon" href="../../static-assets/favicon.png?v1">
  
</head>

<body data-base-href="../../" data-using-base-href="false" class="light-theme">
<div id="overlay-under-drawer"></div>
<header id="title">
  <span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
  <ol class="breadcrumbs gt-separated dark hidden-xs">
    <li><a href="../../index.html">flutter_sound</a></li>
    <li><a href="../../public_flutter_sound_player">public&#47;flutter_sound_player.dart</a></li>
    <li><a href="../../public_flutter_sound_player/FlutterSoundPlayer-class.html">FlutterSoundPlayer</a></li>
    <li class="self-crumb">feedInt16FromStream method</li>
  </ol>
  <div class="self-name">feedInt16FromStream</div>
  <form class="search navbar-right" role="search">
    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
  <div class="toggle" id="theme-button" title="Toggle brightness">
    <label for="theme">
      <input type="checkbox" id="theme" value="light-theme">
      <span id="dark-theme-button" class="material-symbols-outlined">
        dark_mode
      </span>
      <span id="light-theme-button" class="material-symbols-outlined">
        light_mode
      </span>
    </label>
  </div>
</header>
<main>
<div
    id="dartdoc-main-content"
    class="main-content"
    data-above-sidebar="public_flutter_sound_player&#47;FlutterSoundPlayer-class-sidebar.html"
    data-below-sidebar="">
    <div>
<h1><span class="kind-method">feedInt16FromStream</span> method 
</h1></div>

    <section class="multi-line-signature">
      
<span class="returntype"><a href="https://api.flutter.dev/flutter/dart-core/Future-class.html">Future</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>&gt;</span></span>
<span class="name ">feedInt16FromStream</span>(<wbr><ol class="parameter-list single-line"> <li><span class="parameter" id="feedInt16FromStream-param-buffer"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-typed_data/Int16List-class.html">Int16List</a></span>&gt;</span></span> <span class="parameter-name">buffer</span></span></li>
</ol>)

      

    </section>
    
<section class="desc markdown">
  <p>Feed a Int16 stream not interleaved when a flow control is wanted</p>
<hr>
<p>Please look to this <a href="/tau/guides/guides_live_streams.html">small guide</a> if you need help.</p>
<h2 id="parameters">Parameters</h2>
<ul>
<li><strong><em>buffer:</em></strong> is a List of Int16List containing the audio data that you want to play.
The List length must be equal to the number of channels.
All the Int16List length <strong>MUST</strong> be same and contain your data.</li>
</ul>
<h2 id="return">Return</h2>
<p>Returns a Future that you MUST await if you really need a flow control.
This future is declared <em>completed</em> when the data has been played,
or at least when they had be given to the lower layer of the software.
Note: don't use the <code>int</code> returned. It is just for legacy reason and must not be used.</p>
<h2 id="example">Example</h2>
<pre class="language-dart"><code class="language-dart">await myPlayer.startPlayerFromStream
(
    codec: Codec.pcm16
    numChannels: 2
    sampleRate: 48100
    interleaved: false,
);

await myPlayer.feedInt16FromStream(myData);
</code></pre>
<h2 id="see-also">See also</h2>
<ul>
<li><a href="../../public_flutter_sound_player/FlutterSoundPlayer/feedF32FromStream.html">feedF32FromStream()</a></li>
<li><a href="../../public_flutter_sound_player/FlutterSoundPlayer/feedUint8FromStream.html">feedUint8FromStream()</a></li>
<li><a href="../../public_flutter_sound_player/FlutterSoundPlayer/float32Sink.html">float32Sink</a></li>
<li><a href="../../public_flutter_sound_player/FlutterSoundPlayer/int16Sink.html">int16Sink</a></li>
<li><a href="../../public_flutter_sound_player/FlutterSoundPlayer/uint8ListSink.html">uint8ListSink</a></li>
<li>Please look to this <a href="/tau/guides/guides_live_streams.html">small guide</a> if you need help</li>
</ul>
<hr>
</section>


    
<section class="summary source-code" id="source">
  <h2><span>Implementation</span></h2>
  <pre class="language-dart"><code class="language-dart">Future&lt;int&gt; feedInt16FromStream(List&lt;Int16List&gt; buffer) async {
  await _waitOpen();
  if (_isInited != Initialized.fullyInitialized) {
    throw Exception(&#39;Player is not open&#39;);
  }
  if (isStopped) {
    return 0;
  }

  if (codec != Codec.pcm16) {
    logger.e(&#39;Cannot feed with Int16 on a Codec &lt;&gt; pcm16&#39;);
    throw Exception(&#39;Cannot feed with Int16 on a Codec &lt;&gt; pcm16&#39;);
  }
  if (interleaved) {
    logger.e(&#39;Cannot feed with Int16 with interleaved mode&#39;);
    throw Exception(&#39;Cannot feed with Int16 with interleaved mode&#39;);
  }
  if (buffer.length != numChannels) {
    logger.e(
        &#39;feedInt16FromStream() : buffer length (${buffer.length}) != the number of channels ($numChannels)&#39;);
    throw Exception(
        &#39;feedInt16FromStream() : buffer length (${buffer.length}) != the number of channels ($numChannels)&#39;);
  }
  for (int channel = 1; channel &lt; numChannels; ++channel) {
    if (buffer[channel].length != buffer[0].length) {
      logger.e(
          &#39;feedInt16FromStream() : buffer length[0] (${buffer[0].length}) != the number of channels ($numChannels)&#39;);
      throw Exception(
          &#39;feedInt16FromStream() : buffer length[0] (${buffer.length}) != buffer[$channel].length (${buffer[channel].length})&#39;);
    }
  }

  _needSomeFoodCompleter =
      Completer&lt;int&gt;(); &#47;&#47; Not completed until the device accept new data
  try {
    var ln = await (FlutterSoundPlayerPlatform.instance.feedInt16(
      this,
      data: buffer,
    ));
    assert(ln &gt;= 0); &#47;&#47; feedFromStream() is not happy if &lt; 0
    if (ln != 0) {
      &#47;&#47; If the device accepted some data, then no need to wait
      &#47;&#47; It is the tau_core responsability to send a &quot;needSomeFood&quot; then it is again available for new data
      _needSomeFoodCompleter = null;
      return (ln);
    } else {
      &#47;&#47;logger.i(&quot;The device has enough data&quot;);
    }
  } on Exception {
    _needSomeFoodCompleter = null;
    if (isStopped) {
      return 0;
    }
    rethrow;
  }

  if (_needSomeFoodCompleter != null) {
    return _needSomeFoodCompleter!.future;
  }
  return 0;
}</code></pre>
</section>


  </div> <!-- /.main-content -->
  <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
    <!-- The search input and breadcrumbs below are only responsively visible at low resolutions. -->
<header id="header-search-sidebar" class="hidden-l">
  <form class="search-sidebar" role="search">
    <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
</header>
<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
    <li><a href="../../index.html">flutter_sound</a></li>
    <li><a href="../../public_flutter_sound_player">flutter_sound_player</a></li>
    <li><a href="../../public_flutter_sound_player/FlutterSoundPlayer-class.html">FlutterSoundPlayer</a></li>
    <li class="self-crumb">feedInt16FromStream method</li>
</ol>

    <h5>FlutterSoundPlayer class</h5>
    <div id="dartdoc-sidebar-left-content"></div>
  </div><!--/.sidebar-offcanvas-->
  <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
</div><!--/.sidebar-offcanvas-->
</main>
<footer>
  <span class="no-break">
    flutter_sound
      9.28.0
  </span>
  
</footer>


<script src="../../static-assets/highlight.pack.js?v1"></script>
<script src="../../static-assets/docs.dart.js"></script>

</body>
</html>

